home *** CD-ROM | disk | FTP | other *** search
/ Speccy ClassiX 1998 / Speccy ClassiX 98.iso / amiga_system / the_aminet / dev / gui / gutil_3656.readme < prev    next >
Text File  |  1995-11-09  |  17KB  |  337 lines
  1. Short:    GUI creation library (small & fast)
  2. Author:   P-O Yliniemi / Staffan HΣmΣlΣ
  3. Uploader: P-O Yliniemi
  4. Version:  36.56
  5. Type:     dev/gui + util/libs
  6.  
  7. This library is currently in its ▀eta testing stage. The only thing that
  8. is missing is some of the docs. All advanced functions are described, and
  9. all less advanced functions have at least a short usage docs.
  10.  
  11. Some examples may have weird names (for those who don't understand swedish),
  12. and some text files may be in swedish. This will be fixed for next release.
  13.  
  14. Two versions of the .library file is available with this developer package.
  15. One is the "normal" library, and the other one prints out a lot of info when
  16. executing a program that uses GadUtil.
  17.  
  18. If you need to use the debug version, rename the normal version in libs:,
  19. copy the debug version to libs, and rename it to gadutil.library. Reverse
  20. this to change back to the normal version. Don't forget to "flush" all
  21. unused libraries or reboot before testing the program again.
  22.  
  23. All necessary files for Asm & C development are included.
  24.  
  25.                                           P-O 951026
  26.                                           ~~~~~~~~~~
  27. ------------------------------------------------------------------------------
  28.  
  29.                             GadUtil.library v36.56
  30.                             ~~~~~~~~~~~~~~~~~~~~~~
  31.     GadUtil is another gui library which main goal was to make it easy to
  32.     create font sensitive user interfaces. The library has grown away from
  33.     this main goal, and become another useful-routine-library.
  34.  
  35.   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  36.     Distribution:
  37.  
  38.         1) Distribution of this library is allowed in two ways:
  39.              ╣) Only the .library file
  40.              ▓) The complete distribution
  41.  
  42.         2) Programmers of totally free software can use and distribute this
  43.           library for free.
  44.  
  45.         3) Programmers of Shareware, Licensware, commercial products and other
  46.            programs that the programmer get any kind of profit from shall send
  47.            a fully working (and registered) copy of the program and its docs to
  48.            us. All larger updates of the program should also be sent to us.
  49.           
  50.         4) Programmers of non-free software not covered by 1) and 2) (my Diskware
  51.            concept belongs to this group) shall be treated as in 3) (a fully
  52.            working and registered copy...).
  53.  
  54.         5) All programs (except commercial products in some cases) must state
  55.            that gadutil.library is used. This may be done in either the About
  56.            requester or in the documentation, but best of all in both places.
  57.  
  58.            Demonstration programs for gadutil.library (that includes the full
  59.            source) may be distributed without this note.
  60.  
  61.            Example for inclusion in About requester:
  62.  
  63.                 "This program uses gadutil.library, which
  64.                  is Copyright ⌐ 1994-1995 by P-O Yliniemi
  65.                  and Staffan HΣmΣlΣ."
  66.  
  67.         6) All localized programs that uses this library should include the
  68.            .ct file(s) to allow anyone to translate that program into their
  69.            own language.
  70.  
  71.  
  72.   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  73.     Below is a list of some of the main functions covered by this library.
  74.  
  75.     * FAST (NO OR VERY SMALL DIFFERENCE AGAINST GADTOOLS) AND SMALL (LESS THAN 10k).
  76.       WRITTEN IN ASSEMBLY LANGUAGE. NO F*CKING 'C' or any other slow language!
  77.  
  78.     * Font adaptive. Use any of the system fonts and most other fonts for
  79.       gadgets, texts and menus. All gadgets are placed relative to each
  80.       other, but can be placed at absolute positions (needed for the first
  81.       gadget).
  82.  
  83.     * No need to use GIMMEZEROZERO windows, as this is automatically handled
  84.       by the library. If you specify a gadget position of 10,10 the gadget
  85.       will be placed at 10,10 within the window's border.
  86.  
  87.     * Localized. It is really easy to localize all your (new) programs by
  88.       using this library. Functions and macros for creating localized menus
  89.       are supplied.
  90.  
  91.     * Both assembly and 'C' language support. This is one of the things that is
  92.       missing in most of the other gui libraries. Some extra macros are defined
  93.       for assembly language users, and will make the gadget and menu creating
  94.       process even more easy.
  95.  
  96.     * All GadTools gadgets are supported. Some extra functions are provided
  97.       for ListViews. BUTTON_KIND (and IMAGE_KIND) gadgets have some extra tags,
  98.       including a toggle-select option.
  99.  
  100.       5 extended gadget types are handled by the library:
  101.     
  102.         ╖ FILE_KIND     - gadget for selecting a file.
  103.  
  104.         ╖ DRAWER_KIND   - gadget for selecting a drawer. Most programs also
  105.                          use this gadget for file selection.
  106.  
  107.         ╖ IMAGE_KIND    - uses an intuition image for the gadget. Can use
  108.                           different images for selected and non-selected state.
  109.  
  110.         ╖ BEVELBOX_KIND - gadtools bevelboxes, with some extensions. All
  111.                           gadtools bevelboxes are supported (even with v37).
  112.                           Extensions allows text to be placed above, in or below
  113.                           the upper line of the box. All kinds can be inverted.
  114.  
  115.                           New for v36.52: Bevelbox text placement extended.
  116.                           3 new placements available together with the old
  117.                           ones: centered, left adjusted & right adjusted.
  118.  
  119.                           BFT_BUTTON   - GT v37 BUTTON_KIND border
  120.                           BFT_RIDGE    - GT v37 STRING_KIND border
  121.                           BFT_DROPBOX  - GT v39 BBFT_ICONDROPBOX border
  122.                           BFT_HORIZBAR - A horizontal shadowed line
  123.                           BFT_VERTBAR  - A vertical shadowed line
  124.  
  125.                           This makes it a total of 100 bevel box types. The bevel
  126.                           boxes are treated as gadgets by the library, and you
  127.                           can obtain the structure for the bevelbox in the same
  128.                           way as you get the gadget pointer.
  129.  
  130.                           New for v36.53: Added optional shadow on bevel box text.
  131.                           The shadow has a selectable color/pen and the "sun" can
  132.                           be placed in four different positions.
  133.  
  134.         ╖ PROGRESS_KIND - progress indicator gadget. Background and fill color
  135.                           can be selected. Supports values up to 4.294.967.295,
  136.                           but maximum value should not exceed 4.294.967.295/width.
  137.                           v36.55.
  138.  
  139.     * Can create the minimum required IDCMP mask so that all gadgets works.
  140.  
  141.     * A new OpenFont (graphics.library and diskfont.library replacement) is supplied.
  142.       This function will open any font (from RAM, ROM or load it from disk).
  143.  
  144.     * Functions for listviews include adding nodes (memory for the string is
  145.       allocated by the function), counting nodes, getting node pointers, clearing
  146.       a listview, attach and detach lists, moving nodes up and down.
  147.  
  148.     * No need to open gadtools.library anymore, since all gadtools functions are
  149.       provided through this library. Some (the most useable) functions from locale
  150.       library are also provided by gadutil.
  151.  
  152.     * Many libraries are opened through gadutil.library, and these library bases
  153.       are available for your own use (you don't have to open or close some libs).
  154.  
  155.     * All gadgets are created using tag lists. Every next gadget will use the
  156.       previous gadgets values as defaults. Only one call to the gadget making
  157.       routine is needed for every gadget list.
  158.  
  159.     * All gadgets can have their own hotkey. No extra work is needed by the
  160.       programmer (only one extra tag).
  161.  
  162.     * Distributed with lots of examples, mostly in assembly language, but also
  163.       in 'C'.
  164.  
  165.     * Other functions include:
  166.  
  167.         ╖ Status change for toggle select buttons.
  168.  
  169.         ╖ String change for STRING and TEXT_KIND gadgets.
  170.  
  171.         ╖ Disable functions for all gadget kinds (new for 36.56).
  172.  
  173.         ╖ Routines to set up a busy-pointer (available for both v37 and v39). These
  174.           routines also blocks the input to the main window of the program.
  175.  
  176.         ╖ Routine to check if the mouse pointer is within a gadgets box. Useful
  177.           for mouse-position sensitive appwindows.
  178.  
  179.         ╖ Bevelbox and window refreshing functions.
  180.  
  181.     * FAST (NO OR VERY SMALL DIFFERENCE AGAINST GADTOOLS) AND SMALL (LESS THAN 10k).
  182.       WRITTEN IN ASSEMBLY LANGUAGE. NO F*CKING 'C' or any other slow language!
  183.  
  184.  
  185.   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  186.   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  187.         Per-Olof Yliniemi                           Staffan HΣmΣlΣ
  188.         Box 78                                      PellovΣgen 268
  189.         S-980 61 TΣrend÷                            S-957 93 Pello
  190.         SWEDEN                                      SWEDEN
  191.  
  192.         email:                                      email:
  193.           P-O_Yliniemi@spectre.talshiar.pp.se         < no address for now >
  194.  
  195.         phone:
  196.           +46-(0)978-20522
  197.  
  198.         Don't send programs through e-mail, since I have no way to regulary check
  199.         my mail!
  200.  
  201.   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  202.   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  203.  
  204.  
  205. ============================= Archive contents =============================
  206.  
  207. Original  Packed Ratio    Date     Time    Name
  208. -------- ------- ----- --------- --------  -------------
  209.      532     306 42.4% 26-Oct-95 07:42:02 +- MakeArchive -.info
  210.      564     229 59.3% 01-Sep-95 21:18:12 +CatalogUtils.info
  211.      296     144 51.3% 16-Jun-95 17:08:34 +ASM-One_Data.sd
  212.    23292   13027 44.0% 21-Feb-95 18:49:44 +FlexCat
  213.    47196   14536 69.2% 16-Jun-95 17:10:36 +FlexCat_Eng.guide
  214.     1698     645 62.0% 31-Aug-95 10:23:40 +FlexCat_Quick.doc
  215.      305     160 47.5% 16-Jun-95 17:09:24 +Lattice_Data.sd
  216.      564     229 59.3% 15-Sep-95 11:57:10 +Docs.info
  217.      564     233 58.6% 01-Sep-95 20:55:22 +AutoDocs.info
  218.     1462     360 75.3% 27-May-95 18:49:42 +00.GU_TableOfContents
  219.     3445    1498 56.5% 18-Jun-95 20:58:26 +01.GU_LayoutGadgetsA
  220.    21512    5506 74.4% 10-Oct-95 20:42:12 +01.GU_PreliminaryDocs
  221.      374     192 48.6% 09-Jan-95 13:58:26 +02.GU_FreeLayoutGadgets
  222.     3360    1419 57.7% 17-Jun-95 15:00:10 +03.GU_CreateGadgetA
  223.     1542     725 52.9% 18-Jun-95 22:10:52 +04.GU_SetGadgetAttrsA
  224.     1761     884 49.8% 17-Jun-95 15:02:24 +05.GU_GetIMsg
  225.      727     361 50.3% 27-May-95 23:13:04 +06.GU_CountNodes
  226.      408     219 46.3% 09-Jan-95 13:59:06 +07.GU_GadgetArrayIndex
  227.      765     379 50.4% 08-Feb-95 22:45:58 +08.GU_BlockInput
  228.      598     302 49.4% 16-Jun-95 21:26:20 +09.GU_FreeInput
  229.      639     333 47.8% 18-Jun-95 21:42:58 +10.GU_FreeGadgets
  230.      445     247 44.4% 09-Jan-95 14:00:30 +11.GU_SetGUGadAttrsA
  231.     1726     799 53.7% 08-Feb-95 23:23:24 +12.GU_CoordsInGadBox
  232.     3576    1167 67.3% 16-Jun-95 20:57:00 +13.GU_GetGadgetPtr
  233.      677     350 48.3% 16-Jun-95 19:15:10 +14.GU_TextWidth
  234.      906     411 54.6% 18-Jun-95 20:18:58 +15.GU_GetLocaleStr
  235.     1877     823 56.1% 16-Jun-95 21:30:30 +16.GU_CreateLocMenuA
  236.     2238     966 56.8% 18-Jun-95 20:12:00 +17.GU_OpenCatalog
  237.      685     356 48.0% 18-Jun-95 20:17:40 +18.GU_CloseCatalog
  238.      390     209 46.4% 09-Jan-95 14:01:32 +19.GU_DisableGadget
  239.      388     219 43.5% 09-Jan-95 14:01:38 +20.GU_SetToggle
  240.      367     204 44.4% 10-Jan-95 12:37:50 +21.GU_RefreshBoxes
  241.     1062     512 51.7% 18-Jun-95 22:01:42 +22.GU_RefreshWindow
  242.      370     212 42.7% 13-Jan-95 21:45:24 +23.GU_OpenFont
  243.      317     183 42.2% 13-Jan-95 21:58:46 +24.GU_NewList
  244.      399     222 44.3% 13-Jan-95 22:02:24 +25.GU_ClearList
  245.      367     208 43.3% 13-Jan-95 22:08:42 +26.GU_DetachList
  246.      383     214 44.1% 13-Jan-95 22:11:52 +27.GU_AttachList
  247.      400     226 43.5% 11-Feb-95 12:06:16 +28.GU_AddTail
  248.      381     215 43.5% 11-Feb-95 12:04:46 +29.GU_ChangeStr
  249.      404     211 47.7% 18-Jun-95 21:34:06 +30.GU_CreateContext
  250.      539     278 48.4% 18-Jun-95 21:49:34 +31.GU_GetGadgetAttrsA
  251.      467     249 46.6% 18-Jun-95 21:42:04 +32.GU_CreateMenusA
  252.      377     206 45.3% 18-Jun-95 21:40:30 +33.GU_FreeMenus
  253.      493     259 47.4% 18-Jun-95 22:11:56 +34.GU_LayoutMenuItemsA
  254.      466     261 43.9% 18-Jun-95 22:12:42 +35.GU_LayoutMenusA
  255.      510     266 47.8% 18-Jun-95 21:45:46 +36.GU_GetVisualInfoA
  256.      396     207 47.7% 18-Jun-95 21:44:38 +37.GU_FreeVisualInfo
  257.      412     221 46.3% 18-Jun-95 21:46:46 +38.GU_BeginRefresh
  258.      423     235 44.4% 18-Jun-95 21:47:36 +39.GU_EndRefresh
  259.      441     228 48.2% 18-Jun-95 21:48:22 +40.GU_FilterIMsg
  260.      485     250 48.4% 18-Jun-95 21:50:54 +41.GU_PostFilterIMsg
  261.     1028     510 50.3% 18-Jun-95 22:09:50 +42.GU_ReplyIMsg
  262.      499     269 46.0% 18-Jun-95 21:42:34 +43.GU_DrawBevelBoxA
  263.      376     209 44.4% 11-Feb-95 12:00:16 +44.GU_FindNode
  264.      375     214 42.9% 11-Feb-95 12:05:36 +45.GU_NodeUp
  265.      383     219 42.8% 11-Feb-95 12:05:50 +46.GU_NodeDown
  266.      971     427 56.0% 10-Oct-95 20:56:40 +47.GU_UpdateProgress
  267.      334     173 48.2% 09-Jan-95 14:01:46 +99.GU_NewFunction
  268.    47426   16585 65.0% 16-Oct-95 21:04:52 +dev_historia.guide
  269.     7129    2528 64.5% 04-Jul-95 22:43:18 +dev_history.guide
  270.     7342    1328 81.9% 02-Nov-94 13:58:34 +gadtools.tags
  271.    62592   16713 73.2% 16-Oct-95 21:39:38 +GadUtil.doc
  272.    77340   18156 76.5% 16-Oct-95 21:55:18 +GadUtil.guide
  273.     1276     763 40.2% 16-Oct-95 21:56:20 +GadUtil.guide.info
  274.     1640     738 55.0% 30-Aug-95 11:31:22 +GadUtil.manual
  275.      490     196 60.0% 30-Aug-95 11:20:04 +GadUtil.manual.info
  276.     7712    2822 63.4% 30-Aug-95 11:33:56 +GUtilInfo.txt
  277.      340      97 71.4% 04-Jan-95 15:42:12 +PrivateFunctions
  278.      564     235 58.3% 01-Sep-95 21:18:14 +Examples.info
  279.     7009    2581 63.1% 20-Apr-95 19:59:30 +- GadToolsBug.s -
  280.      564     230 59.2% 20-Apr-95 20:29:52 +AnyProgram.info
  281.     1261     625 50.4% 23-Feb-95 17:17:12 +- LΣs den hΣr -
  282.     1059     550 48.0% 23-Feb-95 16:09:28 +anyprogram.cd
  283.     1567     800 48.9% 16-Jun-95 17:50:36 +anyprogram.ct
  284.    21381    6958 67.4% 30-Aug-95 12:02:14 +AnyProgram.s
  285.      564     226 59.9% 20-Apr-95 20:29:54 +BetterTest-C.info
  286.     8216    4688 42.9% 16-Jan-95 20:49:58 +BetterTest
  287.    12185    3511 71.1% 16-Jan-95 20:50:04 +BetterTest.c
  288.      835     395 52.6% 16-Jan-95 20:49:58 +BetterTest.info
  289.      229     134 41.4% 26-Dec-94 01:06:30 +led.asm
  290.      120     100 16.6% 26-Dec-94 01:06:32 +led.o
  291.      564     232 58.8% 20-Apr-95 20:29:42 +BetterTest.info
  292.     3252    1737 46.5% 08-Jan-95 01:58:36 +BetterTest
  293.      653     338 48.2% 16-Jun-95 20:35:54 +BetterTest.cd
  294.      563     324 42.4% 16-Jun-95 20:36:04 +BetterTest.ct
  295.    17129    5067 70.4% 12-Apr-95 22:51:14 +BetterTest.s
  296.      446     260 41.7% 12-Dec-94 23:25:18 +BetterTest.catalog
  297.    10027    2838 71.6% 20-Apr-95 20:00:10 +BevelTest.s
  298.     1260     496 60.6% 20-Apr-95 20:01:02 +ExternTestInit.s
  299.    13914    4475 67.8% 12-Apr-95 22:41:02 +LVTest.s
  300.    17492    5051 71.1% 30-Aug-95 21:29:04 +mytestprog.s
  301.      564     232 58.8% 20-Apr-95 20:29:48 +OldInternal.info
  302.      360     226 37.2% 05-Jan-95 23:22:18 +internaltest.catalog
  303.      461     258 44.0% 05-Jan-95 23:22:22 +internaltest.cd
  304.      447     279 37.5% 05-Jan-95 23:22:22 +internaltest.ct
  305.    13664    3792 72.2% 30-Aug-95 11:41:26 +OldInternal.s
  306.      564     230 59.2% 20-Apr-95 20:29:46 +OldTestProgs.info
  307.    10082    2765 72.5% 30-Aug-95 12:20:36 +GadUtilLibTest.s
  308.    16625    5298 68.1% 20-Apr-95 20:16:00 +HotKeysTest.s
  309.     1996    1055 47.1% 08-Dec-94 13:57:20 +TBLR_test
  310.    11548    3203 72.2% 30-Aug-95 12:53:24 +TBLR_test.s
  311.     8086    2828 65.0% 30-Aug-95 11:58:02 +ThreeGadgets.s
  312.      564     226 59.9% 01-Sep-95 21:18:12 +ExtraCmds.info
  313.    25044   14574 41.8% 17-Jun-95 14:42:44 +AskEnv
  314.    16676    8650 48.1% 05-Jan-95 20:25:34 +fd2pragma
  315.     2754    1289 53.1% 05-Jan-95 20:25:48 +fd2pragma.readme
  316.     5932    3511 40.8% 17-Jun-95 14:42:46 +XIcon
  317.      959     370 61.4% 15-Sep-95 12:34:16 +def_doc.info
  318.     1276     761 40.3% 15-Sep-95 12:34:18 +def_guide.info
  319.      564     225 60.1% 01-Sep-95 21:18:14 +Include.info
  320.     3193     939 70.5% 21-Oct-95 20:54:50 +gadutil_protos.h
  321.     2312     902 60.9% 21-Oct-95 20:55:02 +gadutil_lib.fd
  322.    17245    4851 71.8% 21-Oct-95 20:55:32 +gadutil.h
  323.    17230    5127 70.2% 21-Oct-95 20:55:58 +gadutil.i
  324.     3391    1081 68.1% 21-Oct-95 20:55:12 +gadutil_lib.i
  325.    43346   10021 76.8% 31-Aug-95 16:31:34 +LVOs.i
  326.      184     128 30.4% 24-Dec-94 13:55:02 +gadutil.h
  327.    23959    5802 75.7% 15-Sep-95 12:35:04 +Install
  328.     1856    1005 45.8% 08-Sep-95 15:36:24 +Install.info
  329.     3931     671 82.9% 17-Jun-95 14:50:42 +install.script
  330.     1409     525 62.7% 01-Jun-95 19:09:50 +InstallInc.gad
  331.      549     320 41.7% 01-Sep-95 21:18:14 +InstallInc.info
  332.      564     232 58.8% 01-Sep-95 21:18:14 +libs.info
  333.    10964    6484 40.8% 16-Oct-95 22:17:36 +gadutil.library
  334.    19188    9333 51.3% 16-Oct-95 22:18:38 +gadutil.library_dbg
  335. -------- ------- ----- --------- --------
  336.   739565  253292 65.7% 28-Oct-95 12:52:18   126 files
  337.